

<!DOCTYPE html>


<html lang="en" >

  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

    <title>Class vtkF3DBitonicSort &#8212; vtkext 2.5.1 documentation</title>
  
  
  
  <script data-cfasync="false">
    document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
    document.documentElement.dataset.theme = localStorage.getItem("theme") || "light";
  </script>
  
  <!-- Loaded before other Sphinx assets -->
  <link href="../_static/styles/theme.css?digest=12da95d707ffb74b382d" rel="stylesheet" />
<link href="../_static/styles/bootstrap.css?digest=12da95d707ffb74b382d" rel="stylesheet" />
<link href="../_static/styles/pydata-sphinx-theme.css?digest=12da95d707ffb74b382d" rel="stylesheet" />

  
  <link href="../_static/vendor/fontawesome/6.1.2/css/all.min.css?digest=12da95d707ffb74b382d" rel="stylesheet" />
  <link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.1.2/webfonts/fa-solid-900.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.1.2/webfonts/fa-brands-400.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.1.2/webfonts/fa-regular-400.woff2" />

    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    <link rel="stylesheet" href="../_static/styles/sphinx-book-theme.css?digest=14f4ca6b54d191a8c7657f6c759bf11a5fb86285" type="text/css" />
    <link rel="stylesheet" type="text/css" href="../_static/collapsible-lists/css/tree_view.css" />
  
  <!-- Pre-loaded scripts that we'll load fully later -->
  <link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=12da95d707ffb74b382d" />
<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=12da95d707ffb74b382d" />

    <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
    <script src="../_static/jquery.js"></script>
    <script src="../_static/underscore.js"></script>
    <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
    <script src="../_static/doctools.js"></script>
    <script src="../_static/sphinx_highlight.js"></script>
    <script src="../_static/scripts/sphinx-book-theme.js?digest=5a5c038af52cf7bc1a1ec88eea08e6366ee68824"></script>
    <script src="../_static/collapsible-lists/js/CollapsibleLists.compressed.js"></script>
    <script src="../_static/collapsible-lists/js/apply-collapsible-lists.js"></script>
    <script>DOCUMENTATION_OPTIONS.pagename = 'api/classvtkF3DBitonicSort';</script>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="Class vtkF3DFaceVaryingPointDispatcher" href="classvtkF3DFaceVaryingPointDispatcher.html" />
    <link rel="prev" title="Library API" href="library_root.html" />
  <meta name="viewport" content="width=device-width, initial-scale=1"/>
  <meta name="docsearch:language" content="en"/>
  </head>
  
  
  <body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="">

  
  
  <a class="skip-link" href="#main-content">Skip to main content</a>
  
  <input type="checkbox"
          class="sidebar-toggle"
          name="__primary"
          id="__primary"/>
  <label class="overlay overlay-primary" for="__primary"></label>
  
  <input type="checkbox"
          class="sidebar-toggle"
          name="__secondary"
          id="__secondary"/>
  <label class="overlay overlay-secondary" for="__secondary"></label>
  
  <div class="search-button__wrapper">
    <div class="search-button__overlay"></div>
    <div class="search-button__search-container">
<form class="bd-search d-flex align-items-center"
      action="../search.html"
      method="get">
  <i class="fa-solid fa-magnifying-glass"></i>
  <input type="search"
         class="form-control"
         name="q"
         id="search-input"
         placeholder="Search..."
         aria-label="Search..."
         autocomplete="off"
         autocorrect="off"
         autocapitalize="off"
         spellcheck="false"/>
  <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form></div>
  </div>
  
    <nav class="bd-header navbar navbar-expand-lg bd-navbar">
    </nav>
  
  <div class="bd-container">
    <div class="bd-container__inner bd-page-width">
      
      <div class="bd-sidebar-primary bd-sidebar">
        

  
  <div class="sidebar-header-items sidebar-primary__section">
    
    
    
    
  </div>
  
    <div class="sidebar-primary-items__start sidebar-primary__section">
        <div class="sidebar-primary-item">
  

<a class="navbar-brand logo" href="../index.html">
  
  
  
  
  
    <p class="title logo__title">vtkext 2.5.1 documentation</p>
  
</a></div>
        <div class="sidebar-primary-item"><nav class="bd-links" id="bd-docs-nav" aria-label="Main">
    <div class="bd-toc-item navbar-nav active">
        <p aria-level="2" class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current nav bd-sidenav">
<li class="toctree-l1 current active has-children"><a class="reference internal" href="library_root.html">Library API</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul class="current">
<li class="toctree-l2 current active"><a class="current reference internal" href="#">Class vtkF3DBitonicSort</a></li>
<li class="toctree-l2"><a class="reference internal" href="classvtkF3DFaceVaryingPointDispatcher.html">Class vtkF3DFaceVaryingPointDispatcher</a></li>
<li class="toctree-l2"><a class="reference internal" href="classvtkF3DGLTFImporter.html">Class vtkF3DGLTFImporter</a></li>
<li class="toctree-l2"><a class="reference internal" href="classvtkF3DImporter.html">Class vtkF3DImporter</a></li>
<li class="toctree-l2"><a class="reference internal" href="function_TestF3DBitonicSort_8cxx_1a9c35c31cc0fb7e40d93b302cddaee286.html">Function TestF3DBitonicSort</a></li>
<li class="toctree-l2"><a class="reference internal" href="function_vtkF3DFaceVaryingPointDispatcher_8cxx_1ad9c00f705d93dae0625202d9bbf6b075.html">Function vtkInformationKeyMacro(vtkF3DFaceVaryingPointDispatcher, INTERPOLATION_TYPE, Integer)</a></li>
<li class="toctree-l2"><a class="reference internal" href="function_vtkF3DImporter_8cxx_1a52b7d3fa4dab2f3494644899827e711e.html">Function vtkInformationKeyMacro(vtkF3DImporter, ACTOR_IS_ARMATURE, Integer)</a></li>
<li class="toctree-l2"><a class="reference internal" href="function_vtkF3DBitonicSort_8cxx_1a50d0a1ddaa7f199622d02894986742e7.html">Function vtkStandardNewMacro(vtkF3DBitonicSort)</a></li>
<li class="toctree-l2"><a class="reference internal" href="function_vtkF3DFaceVaryingPointDispatcher_8cxx_1a7e95720a1452f0763e18f2ae97156271.html">Function vtkStandardNewMacro(vtkF3DFaceVaryingPointDispatcher)</a></li>
<li class="toctree-l2"><a class="reference internal" href="function_vtkF3DGLTFImporter_8cxx_1aeaa454ae7e811d120c059acc61ddfdac.html">Function vtkStandardNewMacro(vtkF3DGLTFImporter)</a></li>
</ul>
</li>
</ul>

    </div>
</nav></div>
    </div>
  
  
  <div class="sidebar-primary-items__end sidebar-primary__section">
  </div>
  
  <div id="rtd-footer-container"></div>


      </div>
      
      <main id="main-content" class="bd-main">
        
        

<div class="sbt-scroll-pixel-helper"></div>

          <div class="bd-content">
            <div class="bd-article-container">
              
              <div class="bd-header-article">
<div class="header-article-items header-article__inner">
  
    <div class="header-article-items__start">
      
        <div class="header-article-item"><label class="sidebar-toggle primary-toggle btn btn-sm" for="__primary" title="Toggle primary sidebar" data-bs-placement="bottom" data-bs-toggle="tooltip">
  <span class="fa-solid fa-bars"></span>
</label></div>
      
    </div>
  
  
    <div class="header-article-items__end">
      
        <div class="header-article-item">

<div class="article-header-buttons">





<div class="dropdown dropdown-download-buttons">
  <button class="btn dropdown-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-label="Download this page">
    <i class="fas fa-download"></i>
  </button>
  <ul class="dropdown-menu">
      
      
      
      <li><a href="../_sources/api/classvtkF3DBitonicSort.rst" target="_blank"
   class="btn btn-sm btn-download-source-button dropdown-item"
   title="Download source file"
   data-bs-placement="left" data-bs-toggle="tooltip"
>
  

<span class="btn__icon-container">
  <i class="fas fa-file"></i>
  </span>
<span class="btn__text-container">.rst</span>
</a>
</li>
      
      
      
      
      <li>
<button onclick="window.print()"
  class="btn btn-sm btn-download-pdf-button dropdown-item"
  title="Print to PDF"
  data-bs-placement="left" data-bs-toggle="tooltip"
>
  

<span class="btn__icon-container">
  <i class="fas fa-file-pdf"></i>
  </span>
<span class="btn__text-container">.pdf</span>
</button>
</li>
      
  </ul>
</div>




<button onclick="toggleFullScreen()"
  class="btn btn-sm btn-fullscreen-button"
  title="Fullscreen mode"
  data-bs-placement="bottom" data-bs-toggle="tooltip"
>
  

<span class="btn__icon-container">
  <i class="fas fa-expand"></i>
  </span>

</button>


<script>
document.write(`
  <button class="theme-switch-button btn btn-sm btn-outline-primary navbar-btn rounded-circle" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
    <span class="theme-switch" data-mode="light"><i class="fa-solid fa-sun"></i></span>
    <span class="theme-switch" data-mode="dark"><i class="fa-solid fa-moon"></i></span>
    <span class="theme-switch" data-mode="auto"><i class="fa-solid fa-circle-half-stroke"></i></span>
  </button>
`);
</script>

<script>
document.write(`
  <button class="btn btn-sm navbar-btn search-button search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
    <i class="fa-solid fa-magnifying-glass"></i>
  </button>
`);
</script>
<label class="sidebar-toggle secondary-toggle btn btn-sm" for="__secondary"title="Toggle secondary sidebar" data-bs-placement="bottom" data-bs-toggle="tooltip">
    <span class="fa-solid fa-list"></span>
</label>
</div></div>
      
    </div>
  
</div>
</div>
              
              

<div id="jb-print-docs-body" class="onlyprint">
    <h1>Class vtkF3DBitonicSort</h1>
    <!-- Table of contents -->
    <div id="print-main-content">
        <div id="jb-print-toc">
            
            <div>
                <h2> Contents </h2>
            </div>
            <nav aria-label="Page">
                <ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#inheritance-relationships">Inheritance Relationships</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#base-type">Base Type</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#class-documentation">Class Documentation</a></li>
</ul>
            </nav>
        </div>
    </div>
</div>

              
                
<div id="searchbox"></div>
                <article class="bd-article" role="main">
                  
  <section id="class-vtkf3dbitonicsort">
<span id="exhale-class-classvtkf3dbitonicsort"></span><h1>Class vtkF3DBitonicSort<a class="headerlink" href="#class-vtkf3dbitonicsort" title="Permalink to this heading">#</a></h1>
<ul class="simple">
<li><p>Defined in <a class="reference internal" href="file_module_vtkF3DBitonicSort.h.html#file-module-vtkf3dbitonicsort-h"><span class="std std-ref">File vtkF3DBitonicSort.h</span></a></p></li>
</ul>
<section id="inheritance-relationships">
<h2>Inheritance Relationships<a class="headerlink" href="#inheritance-relationships" title="Permalink to this heading">#</a></h2>
<section id="base-type">
<h3>Base Type<a class="headerlink" href="#base-type" title="Permalink to this heading">#</a></h3>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">public</span> <span class="pre">vtkObject</span></code></p></li>
</ul>
</section>
</section>
<section id="class-documentation">
<h2>Class Documentation<a class="headerlink" href="#class-documentation" title="Permalink to this heading">#</a></h2>
<dl class="cpp class">
<dt class="sig sig-object cpp" id="_CPPv417vtkF3DBitonicSort">
<span id="_CPPv317vtkF3DBitonicSort"></span><span id="_CPPv217vtkF3DBitonicSort"></span><span id="vtkF3DBitonicSort"></span><span class="target" id="classvtkF3DBitonicSort"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">vtkF3DBitonicSort</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">vtkObject</span></span><a class="headerlink" href="#_CPPv417vtkF3DBitonicSort" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Compute shader used to sort key/value pairs. </p>
<p>This class is used to sort buffers based on the Bitonic Sort algorithm. Inspired by <a class="reference external" href="https://poniesandlight.co.uk/reflect/bitonic_merge_sort/">https://poniesandlight.co.uk/reflect/bitonic_merge_sort/</a> The original code can be found there: <a class="github reference external" href="https://github.com/tgfrerer/island">tgfrerer/island</a> It’s mostly rewritten but some parts are copied (MIT license, Tim Gfrerer) </p>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N17vtkF3DBitonicSort12vtkTypeMacroE17vtkF3DBitonicSort9vtkObject">
<span id="_CPPv3N17vtkF3DBitonicSort12vtkTypeMacroE17vtkF3DBitonicSort9vtkObject"></span><span id="_CPPv2N17vtkF3DBitonicSort12vtkTypeMacroE17vtkF3DBitonicSort9vtkObject"></span><span id="vtkF3DBitonicSort::vtkTypeMacro__vtkF3DBitonicSort.vtkObject"></span><span class="target" id="classvtkF3DBitonicSort_1ac7d33117c6ed24db9e11a926fa6f0da7"></span><span class="sig-name descname"><span class="n"><span class="pre">vtkTypeMacro</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv417vtkF3DBitonicSort" title="vtkF3DBitonicSort"><span class="n"><span class="pre">vtkF3DBitonicSort</span></span></a>, <span class="n"><span class="pre">vtkObject</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N17vtkF3DBitonicSort12vtkTypeMacroE17vtkF3DBitonicSort9vtkObject" title="Permalink to this definition">#</a><br /></dt>
<dd></dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N17vtkF3DBitonicSort10InitializeEiii">
<span id="_CPPv3N17vtkF3DBitonicSort10InitializeEiii"></span><span id="_CPPv2N17vtkF3DBitonicSort10InitializeEiii"></span><span id="vtkF3DBitonicSort::Initialize__i.i.i"></span><span class="target" id="classvtkF3DBitonicSort_1a16c2b14d63d94a27412b3edb0f4a89e8"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Initialize</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">workgroupSize</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">keyType</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">valueType</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N17vtkF3DBitonicSort10InitializeEiii" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Initialize the compute shaders. workgroupSize is the number of threads running in a single GPU workgroup keyType and valueType are the VTK types of the key and value to sort respectively Only VTK_DOUBLE, VTK_FLOAT, VTK_INT and VTK_UNSIGNED_INT are supported Returns true if succeeded </p>
</dd></dl>

<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N17vtkF3DBitonicSort3RunEP21vtkOpenGLRenderWindowiP21vtkOpenGLBufferObjectP21vtkOpenGLBufferObject">
<span id="_CPPv3N17vtkF3DBitonicSort3RunEP21vtkOpenGLRenderWindowiP21vtkOpenGLBufferObjectP21vtkOpenGLBufferObject"></span><span id="_CPPv2N17vtkF3DBitonicSort3RunEP21vtkOpenGLRenderWindowiP21vtkOpenGLBufferObjectP21vtkOpenGLBufferObject"></span><span id="vtkF3DBitonicSort::Run__vtkOpenGLRenderWindowP.i.vtkOpenGLBufferObjectP.vtkOpenGLBufferObjectP"></span><span class="target" id="classvtkF3DBitonicSort_1aab9ad18a9dc9dad0848d64a2e9b982d9"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Run</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">vtkOpenGLRenderWindow</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">context</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">nbPairs</span></span>, <span class="n"><span class="pre">vtkOpenGLBufferObject</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">keys</span></span>, <span class="n"><span class="pre">vtkOpenGLBufferObject</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">values</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N17vtkF3DBitonicSort3RunEP21vtkOpenGLRenderWindowiP21vtkOpenGLBufferObjectP21vtkOpenGLBufferObject" title="Permalink to this definition">#</a><br /></dt>
<dd><p>Run the compute shader and sort the buffers. An OpenGL context must exists and given as input in the first argument nbPairs is the number of element in the buffer keys and values OpenGL buffers keys and values must be valid and containing data types specified when this class has been initialized Returns true if succeeded </p>
</dd></dl>

</div>
<div class="breathe-sectiondef docutils container">
<p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-static-functions">Public Static Functions</p>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N17vtkF3DBitonicSort3NewEv">
<span id="_CPPv3N17vtkF3DBitonicSort3NewEv"></span><span id="_CPPv2N17vtkF3DBitonicSort3NewEv"></span><span id="vtkF3DBitonicSort::New"></span><span class="target" id="classvtkF3DBitonicSort_1ae13d7fdc4a9edd765ad570ff5004d4d6"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv417vtkF3DBitonicSort" title="vtkF3DBitonicSort"><span class="n"><span class="pre">vtkF3DBitonicSort</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">New</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N17vtkF3DBitonicSort3NewEv" title="Permalink to this definition">#</a><br /></dt>
<dd></dd></dl>

</div>
</dd></dl>

</section>
</section>


                </article>
              

              
              
                <footer class="bd-footer-article">
                  <!-- Previous / next buttons -->
<div class="prev-next-area">
    <a class="left-prev"
       href="library_root.html"
       title="previous page">
      <i class="fa-solid fa-angle-left"></i>
      <div class="prev-next-info">
        <p class="prev-next-subtitle">previous</p>
        <p class="prev-next-title">Library API</p>
      </div>
    </a>
    <a class="right-next"
       href="classvtkF3DFaceVaryingPointDispatcher.html"
       title="next page">
      <div class="prev-next-info">
        <p class="prev-next-subtitle">next</p>
        <p class="prev-next-title">Class vtkF3DFaceVaryingPointDispatcher</p>
      </div>
      <i class="fa-solid fa-angle-right"></i>
    </a>
</div>
                </footer>
              
            </div>
            
            
              
                <div class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">

  <div class="sidebar-secondary-item">
  <div class="page-toc tocsection onthispage">
    <i class="fa-solid fa-list"></i> Contents
  </div>
  <nav class="bd-toc-nav page-toc">
    <ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#inheritance-relationships">Inheritance Relationships</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#base-type">Base Type</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#class-documentation">Class Documentation</a></li>
</ul>
  </nav></div>

</div></div>
              
            
          </div>
          <footer class="bd-footer-content">
            <div class="bd-footer-content__inner">
<div class="bd-footer-content__inner container">
  
  <div class="footer-item">
    
<p class="component-author">
By Michael Migliore and Mathieu Westphal
</p>

  </div>
  
  <div class="footer-item">
    
  <p class="copyright">
    
      © Copyright 2024, Michael Migliore and Mathieu Westphal.
      <br/>
    
  </p>

  </div>
  
  <div class="footer-item">
    
  </div>
  
  <div class="footer-item">
    
  </div>
  
</div></div>
          </footer>
        

      </main>
    </div>
  </div>
  
  <!-- Scripts loaded after <body> so the DOM is not blocked -->
  <script src="../_static/scripts/bootstrap.js?digest=12da95d707ffb74b382d"></script>
<script src="../_static/scripts/pydata-sphinx-theme.js?digest=12da95d707ffb74b382d"></script>

  <footer class="bd-footer">
  </footer>
  </body>
</html>